Autogenerated HTML docs for v1.6.3-rc2
diff --git a/RelNotes-1.6.3.txt b/RelNotes-1.6.3.txt index efce29d..7270ef8 100644 --- a/RelNotes-1.6.3.txt +++ b/RelNotes-1.6.3.txt
@@ -152,6 +152,10 @@ knobs you can tweak to work around issues with various versions of the docbook-xsl package. See comments in Documentation/Makefile for details. +* Support for building and testing a subset of git on a system without a + working perl has been improved. + + Fixes since v1.6.2 ------------------ @@ -173,6 +177,6 @@ --- exec >/var/tmp/1 -O=v1.6.3-rc1-1-gea10b60 +O=v1.6.3-rc2 echo O=$(git describe master) git shortlog --no-merges $O..master ^maint
diff --git a/config.txt b/config.txt index 35056e1..3188569 100644 --- a/config.txt +++ b/config.txt
@@ -2,15 +2,15 @@ ------------------ The git configuration file contains a number of variables that affect -the git command's behavior. `.git/config` file for each repository -is used to store the information for that repository, and -`$HOME/.gitconfig` is used to store per user information to give -fallback values for `.git/config` file. The file `/etc/gitconfig` -can be used to store system-wide defaults. +the git command's behavior. The `.git/config` file in each repository +is used to store the configuration for that repository, and +`$HOME/.gitconfig` is used to store a per-user configuration as +fallback values for the `.git/config` file. The file `/etc/gitconfig` +can be used to store a system-wide default configuration. -They can be used by both the git plumbing -and the porcelains. The variables are divided into sections, where -in the fully qualified variable name the variable itself is the last +The configuration variables are used by both the git plumbing +and the porcelains. The variables are divided into sections, wherein +the fully qualified variable name of the variable itself is the last dot-separated segment and the section name is everything before the last dot. The variable names are case-insensitive and only alphanumeric characters are allowed. Some variables may appear multiple times. @@ -26,28 +26,28 @@ the name of the section in square brackets and continues until the next section begins. Section names are not case sensitive. Only alphanumeric characters, `-` and `.` are allowed in section names. Each variable -must belong to some section, which means that there must be section -header before first setting of a variable. +must belong to some section, which means that there must be a section +header before the first setting of a variable. Sections can be further divided into subsections. To begin a subsection put its name in double quotes, separated by space from the section name, -in the section header, like in example below: +in the section header, like in the example below: -------- [section "subsection"] -------- -Subsection names can contain any characters except newline (doublequote -`"` and backslash have to be escaped as `\"` and `\\`, -respectively) and are case sensitive. Section header cannot span multiple +Subsection names are case sensitive and can contain any characters except +newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, +respectively). Section headers cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have `[section]` if you have `[section "subsection"]`, but you don't need to. -There is also (case insensitive) alternative `[section.subsection]` syntax. -In this syntax subsection names follow the same restrictions as for section -name. +There is also a case insensitive alternative `[section.subsection]` syntax. +In this syntax, subsection names follow the same restrictions as for section +names. All the other lines are recognized as setting variables, in the form 'name = value'. If there is no equal sign on the line, the entire line @@ -66,10 +66,10 @@ 'git-config' will ensure that the output is "true" or "false". String values may be entirely or partially enclosed in double quotes. -You need to enclose variable value in double quotes if you want to -preserve leading or trailing whitespace, or if variable value contains -beginning of comment characters (if it contains '#' or ';'). -Double quote `"` and backslash `\` characters in variable value must +You need to enclose variable values in double quotes if you want to +preserve leading or trailing whitespace, or if the variable value contains +comment characters (i.e. it contains '#' or ';'). +Double quote `"` and backslash `\` characters in variable values must be escaped: use `\"` for `"` and `\\` for `\`. The following escape sequences (beside `\"` and `\\`) are recognized: @@ -77,10 +77,10 @@ and `\b` for backspace (BS). No other char escape sequence, nor octal char sequences are valid. -Variable value ending in a `\` is continued on the next line in the +Variable values ending in a `\` are continued on the next line in the customary UNIX fashion. -Some variables may require special value format. +Some variables may require a special value format. Example ~~~~~~~ @@ -707,6 +707,13 @@ especially on slow filesystems. If not set, the value of `transfer.unpackLimit` is used instead. +format.attach:: + Enable multipart/mixed attachments as the default for + 'format-patch'. The value can also be a double quoted string + which will enable attachments as the default and set the + value as the boundary. See the --attach option in + linkgit:git-format-patch[1]. + format.numbered:: A boolean which can enable or disable sequence numbers in patch subjects. It defaults to "auto" which enables it only if there @@ -718,6 +725,14 @@ Additional email headers to include in a patch to be submitted by mail. See linkgit:git-format-patch[1]. +format.cc:: + Additional "Cc:" headers to include in a patch to be submitted + by mail. See the --cc option in linkgit:git-format-patch[1]. + +format.subjectprefix:: + The default for format-patch is to output files with the '[PATCH]' + subject prefix. Use this variable to change that prefix. + format.suffix:: The default for format-patch is to output files with the suffix `.patch`. Use this variable to change that suffix (make sure to @@ -730,11 +745,11 @@ format.thread:: The default threading style for 'git-format-patch'. Can be - either a boolean value, `shallow` or `deep`. 'Shallow' + either a boolean value, `shallow` or `deep`. `shallow` threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the `\--in-reply-to`, and the first patch mail, in this order. - 'Deep' threading makes every mail a reply to the previous one. + `deep` threading makes every mail a reply to the previous one. A true boolean value is the same as `shallow`, and a false value disables threading.
diff --git a/git-config.html b/git-config.html index 2fb14f1..4105d18 100644 --- a/git-config.html +++ b/git-config.html
@@ -776,14 +776,14 @@ <h2 id="_configuration_file">CONFIGURATION FILE</h2> <div class="sectionbody"> <div class="para"><p>The git configuration file contains a number of variables that affect -the git command's behavior. <tt>.git/config</tt> file for each repository -is used to store the information for that repository, and -<tt>$HOME/.gitconfig</tt> is used to store per user information to give -fallback values for <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt> -can be used to store system-wide defaults.</p></div> -<div class="para"><p>They can be used by both the git plumbing -and the porcelains. The variables are divided into sections, where -in the fully qualified variable name the variable itself is the last +the git command's behavior. The <tt>.git/config</tt> file in each repository +is used to store the configuration for that repository, and +<tt>$HOME/.gitconfig</tt> is used to store a per-user configuration as +fallback values for the <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt> +can be used to store a system-wide default configuration.</p></div> +<div class="para"><p>The configuration variables are used by both the git plumbing +and the porcelains. The variables are divided into sections, wherein +the fully qualified variable name of the variable itself is the last dot-separated segment and the section name is everything before the last dot. The variable names are case-insensitive and only alphanumeric characters are allowed. Some variables may appear multiple times.</p></div> @@ -795,25 +795,25 @@ the name of the section in square brackets and continues until the next section begins. Section names are not case sensitive. Only alphanumeric characters, <tt>-</tt> and <tt>.</tt> are allowed in section names. Each variable -must belong to some section, which means that there must be section -header before first setting of a variable.</p></div> +must belong to some section, which means that there must be a section +header before the first setting of a variable.</p></div> <div class="para"><p>Sections can be further divided into subsections. To begin a subsection put its name in double quotes, separated by space from the section name, -in the section header, like in example below:</p></div> +in the section header, like in the example below:</p></div> <div class="listingblock"> <div class="content"> <pre><tt> [section "subsection"] </tt></pre> </div></div> -<div class="para"><p>Subsection names can contain any characters except newline (doublequote -<tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>, -respectively) and are case sensitive. Section header cannot span multiple +<div class="para"><p>Subsection names are case sensitive and can contain any characters except +newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>, +respectively). Section headers cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you don't need to.</p></div> -<div class="para"><p>There is also (case insensitive) alternative <tt>[section.subsection]</tt> syntax. -In this syntax subsection names follow the same restrictions as for section -name.</p></div> +<div class="para"><p>There is also a case insensitive alternative <tt>[section.subsection]</tt> syntax. +In this syntax, subsection names follow the same restrictions as for section +names.</p></div> <div class="para"><p>All the other lines are recognized as setting variables, in the form <em>name = value</em>. If there is no equal sign on the line, the entire line is taken as <em>name</em> and the variable is recognized as boolean "true". @@ -828,18 +828,18 @@ converting value to the canonical form using <em>--bool</em> type specifier; <em>git-config</em> will ensure that the output is "true" or "false".</p></div> <div class="para"><p>String values may be entirely or partially enclosed in double quotes. -You need to enclose variable value in double quotes if you want to -preserve leading or trailing whitespace, or if variable value contains -beginning of comment characters (if it contains <em>#</em> or <em>;</em>). -Double quote <tt>"</tt> and backslash <tt>\</tt> characters in variable value must +You need to enclose variable values in double quotes if you want to +preserve leading or trailing whitespace, or if the variable value contains +comment characters (i.e. it contains <em>#</em> or <em>;</em>). +Double quote <tt>"</tt> and backslash <tt>\</tt> characters in variable values must be escaped: use <tt>\"</tt> for <tt>"</tt> and <tt>\\</tt> for <tt>\</tt>.</p></div> <div class="para"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized: <tt>\n</tt> for newline character (NL), <tt>\t</tt> for horizontal tabulation (HT, TAB) and <tt>\b</tt> for backspace (BS). No other char escape sequence, nor octal char sequences are valid.</p></div> -<div class="para"><p>Variable value ending in a <tt>\</tt> is continued on the next line in the +<div class="para"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the customary UNIX fashion.</p></div> -<div class="para"><p>Some variables may require special value format.</p></div> +<div class="para"><p>Some variables may require a special value format.</p></div> <h3 id="_example">Example</h3><div style="clear:left"></div> <div class="literalblock"> <div class="content"> @@ -1820,6 +1820,18 @@ </p> </dd> <dt> +format.attach +</dt> +<dd> +<p> + Enable multipart/mixed attachments as the default for + <em>format-patch</em>. The value can also be a double quoted string + which will enable attachments as the default and set the + value as the boundary. See the --attach option in + <a href="git-format-patch.html">git-format-patch(1)</a>. +</p> +</dd> +<dt> format.numbered </dt> <dd> @@ -1841,6 +1853,24 @@ </p> </dd> <dt> +format.cc +</dt> +<dd> +<p> + Additional "Cc:" headers to include in a patch to be submitted + by mail. See the --cc option in <a href="git-format-patch.html">git-format-patch(1)</a>. +</p> +</dd> +<dt> +format.subjectprefix +</dt> +<dd> +<p> + The default for format-patch is to output files with the <em>[PATCH]</em> + subject prefix. Use this variable to change that prefix. +</p> +</dd> +<dt> format.suffix </dt> <dd> @@ -1866,11 +1896,11 @@ <dd> <p> The default threading style for <em>git-format-patch</em>. Can be - either a boolean value, <tt>shallow</tt> or <tt>deep</tt>. <em>Shallow</em> + either a boolean value, <tt>shallow</tt> or <tt>deep</tt>. <tt>shallow</tt> threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the <tt>--in-reply-to</tt>, and the first patch mail, in this order. - <em>Deep</em> threading makes every mail a reply to the previous one. + <tt>deep</tt> threading makes every mail a reply to the previous one. A true boolean value is the same as <tt>shallow</tt>, and a false value disables threading. </p> @@ -3263,7 +3293,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2009-04-20 08:17:44 UTC +Last updated 2009-04-25 08:29:43 UTC </div> </div> </body>
diff --git a/git-format-patch.html b/git-format-patch.html index cc84c34..885849e 100644 --- a/git-format-patch.html +++ b/git-format-patch.html
@@ -321,10 +321,10 @@ <h2>SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="content"><em>git format-patch</em> [-k] [-o <dir> | --stdout] [--thread] - [--attach[=<boundary>] | --inline[=<boundary>] | - [--no-attach]] - [-s | --signoff] [<common diff options>] +<div class="content"><em>git format-patch</em> [-k] [(-o|--output-directory) <dir> | --stdout] + [--thread[=<style>]] + [(--attach|--inline)[=<boundary>] | --no-attach] + [-s | --signoff] [-n | --numbered | -N | --no-numbered] [--start-number <n>] [--numbered-files] [--in-reply-to=Message-Id] [--suffix=.<sfx>] @@ -332,6 +332,7 @@ [--subject-prefix=Subject-Prefix] [--cc=<email>] [--cover-letter] + [<common diff options>] [ <since> | <revision range> ]</div></div> </div> <h2 id="_description">DESCRIPTION</h2> @@ -999,9 +1000,9 @@ the Message-Id header to reference. </p> <div class="para"><p>The optional <style> argument can be either <tt>shallow</tt> or <tt>deep</tt>. -<em>Shallow</em> threading makes every mail a reply to the head of the +<em>shallow</em> threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the -<tt>--in-reply-to</tt>, and the first patch mail, in this order. <em>Deep</em> +<tt>--in-reply-to</tt>, and the first patch mail, in this order. <em>deep</em> threading makes every mail a reply to the previous one. If not specified, defaults to the <em>format.thread</em> configuration, or <tt>shallow</tt> if that is not set.</p></div> @@ -1075,22 +1076,21 @@ <p> Instead of using <tt>.patch</tt> as the suffix for generated filenames, use specified suffix. A common alternative is - <tt>--suffix=.txt</tt>. + <tt>--suffix=.txt</tt>. Leaving this empty will remove the <tt>.patch</tt> + suffix. </p> -<div class="para"><p>Note that you would need to include the leading dot <tt>.</tt> if you -want a filename like <tt>0001-description-of-my-change.patch</tt>, and -the first letter does not have to be a dot. Leaving it empty would -not add any suffix.</p></div> +<div class="para"><p>Note that the leading character does not have to be a dot; for example, +you can use <tt>--suffix=-patch</tt> to get <tt>0001-description-of-my-change-patch</tt>.</p></div> </dd> <dt> --no-binary </dt> <dd> <p> - Don't output contents of changes in binary files, just take note - that they differ. Note that this disable the patch to be properly - applied. By default the contents of changes in those files are - encoded in the patch. + Do not output contents of changes in binary files, instead + display a notice that those files changed. Patches generated + using this option cannot be applied properly, but they are + still useful for code review. </p> </dd> <dt> @@ -1109,10 +1109,10 @@ </div> <h2 id="_configuration">CONFIGURATION</h2> <div class="sectionbody"> -<div class="para"><p>You can specify extra mail header lines to be added to each message -in the repository configuration, new defaults for the subject prefix -and file suffix, control attachments, and number patches when outputting -more than one.</p></div> +<div class="para"><p>You can specify extra mail header lines to be added to each message, +defaults for the subject prefix and file suffix, number patches when +outputting more than one patch, add "Cc:" headers, configure attachments, +and sign off patches with configuration variables.</p></div> <div class="listingblock"> <div class="content"> <pre><tt>[format] @@ -1169,8 +1169,8 @@ </div></div> <div class="para"><p>Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch. A renaming patch reduces -the amount of text output, and generally makes it easier to review it. -Note that the "patch" program does not understand renaming patches, so +the amount of text output, and generally makes it easier to review. +Note that non-git "patch" programs won't understand renaming patches, so use it only when you know the recipient uses git to apply your patch.</p></div> </li> <li> @@ -1203,7 +1203,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2009-04-21 08:10:52 UTC +Last updated 2009-04-25 08:29:43 UTC </div> </div> </body>
diff --git a/git-format-patch.txt b/git-format-patch.txt index 5eddca9..6f1fc80 100644 --- a/git-format-patch.txt +++ b/git-format-patch.txt
@@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] -'git format-patch' [-k] [-o <dir> | --stdout] [--thread] - [--attach[=<boundary>] | --inline[=<boundary>] | - [--no-attach]] - [-s | --signoff] [<common diff options>] +'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout] + [--thread[=<style>]] + [(--attach|--inline)[=<boundary>] | --no-attach] + [-s | --signoff] [-n | --numbered | -N | --no-numbered] [--start-number <n>] [--numbered-files] [--in-reply-to=Message-Id] [--suffix=.<sfx>] @@ -20,6 +20,7 @@ [--subject-prefix=Subject-Prefix] [--cc=<email>] [--cover-letter] + [<common diff options>] [ <since> | <revision range> ] DESCRIPTION @@ -128,9 +129,9 @@ the Message-Id header to reference. + The optional <style> argument can be either `shallow` or `deep`. -'Shallow' threading makes every mail a reply to the head of the +'shallow' threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the -`\--in-reply-to`, and the first patch mail, in this order. 'Deep' +`\--in-reply-to`, and the first patch mail, in this order. 'deep' threading makes every mail a reply to the previous one. If not specified, defaults to the 'format.thread' configuration, or `shallow` if that is not set. @@ -170,18 +171,17 @@ --suffix=.<sfx>:: Instead of using `.patch` as the suffix for generated filenames, use specified suffix. A common alternative is - `--suffix=.txt`. + `--suffix=.txt`. Leaving this empty will remove the `.patch` + suffix. + -Note that you would need to include the leading dot `.` if you -want a filename like `0001-description-of-my-change.patch`, and -the first letter does not have to be a dot. Leaving it empty would -not add any suffix. +Note that the leading character does not have to be a dot; for example, +you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`. --no-binary:: - Don't output contents of changes in binary files, just take note - that they differ. Note that this disable the patch to be properly - applied. By default the contents of changes in those files are - encoded in the patch. + Do not output contents of changes in binary files, instead + display a notice that those files changed. Patches generated + using this option cannot be applied properly, but they are + still useful for code review. --root:: Treat the revision argument as a <revision range>, even if it @@ -192,10 +192,10 @@ CONFIGURATION ------------- -You can specify extra mail header lines to be added to each message -in the repository configuration, new defaults for the subject prefix -and file suffix, control attachments, and number patches when outputting -more than one. +You can specify extra mail header lines to be added to each message, +defaults for the subject prefix and file suffix, number patches when +outputting more than one patch, add "Cc:" headers, configure attachments, +and sign off patches with configuration variables. ------------ [format] @@ -243,8 +243,8 @@ + Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch. A renaming patch reduces -the amount of text output, and generally makes it easier to review it. -Note that the "patch" program does not understand renaming patches, so +the amount of text output, and generally makes it easier to review. +Note that non-git "patch" programs won't understand renaming patches, so use it only when you know the recipient uses git to apply your patch. * Extract three topmost commits from the current branch and format them
diff --git a/git-show-branch.html b/git-show-branch.html index 042276a..57abe3f 100644 --- a/git-show-branch.html +++ b/git-show-branch.html
@@ -536,9 +536,10 @@ *++ [master] Add 'git show-branch'.</tt></pre> </div></div> <div class="para"><p>These three branches all forked from a common commit, [master], -whose commit message is "Add <em>git show-branch</em>. "fixes" branch -adds one commit <em>Introduce "reset type"</em>. "mhf" branch has many -other commits. The current branch is "master".</p></div> +whose commit message is "Add 'git show-branch'". The "fixes" +branch adds one commit "Introduce "reset type" flag to "git reset"". +The "mhf" branch adds many other commits. The current branch +is "master".</p></div> </div> <h2 id="_example">EXAMPLE</h2> <div class="sectionbody"> @@ -577,7 +578,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2009-04-02 06:50:04 UTC +Last updated 2009-04-25 08:29:43 UTC </div> </div> </body>
diff --git a/git-show-branch.txt b/git-show-branch.txt index 7e9ff37..51a4e9d 100644 --- a/git-show-branch.txt +++ b/git-show-branch.txt
@@ -148,9 +148,10 @@ ------------------------------------------------ These three branches all forked from a common commit, [master], -whose commit message is "Add 'git show-branch'. "fixes" branch -adds one commit 'Introduce "reset type"'. "mhf" branch has many -other commits. The current branch is "master". +whose commit message is "Add \'git show-branch\'". The "fixes" +branch adds one commit "Introduce "reset type" flag to "git reset"". +The "mhf" branch adds many other commits. The current branch +is "master". EXAMPLE
